APIを使用するにはAPIエンドポイントとトークンなどが必要です。 API使用準備を参考にしてAPI使用に必要な情報を準備します。
Floating IP APIはnetworkタイプのエンドポイントを利用します。正確なエンドポイントはトークン発行レスポンスのserviceCatalogを参照します。
| タイプ | リージョン | エンドポイント |
|---|---|---|
| network | 韓国(パンギョ)リージョン 韓国(ピョンチョン)リージョン 日本リージョン |
https://kr1-api-network-infrastructure.nhncloudservice.com https://kr2-api-network-infrastructure.nhncloudservice.com https://jp1-api-network-infrastructure.nhncloudservice.com |
APIレスポンスにガイドに明示されていないフィールドが現れることがあります。これらのフィールドはTOAST内部用途で使用され、事前の告知なしに変更されることがあるため使用しません。
Floating IPリストを返します。
GET /v2.0/floatingips
X-Auth-Token: {tokenId}
このAPIはリクエスト本文を要求しません。
| 名前 | 種類 | 形式 | 必須 | 説明 |
|---|---|---|---|---|
| tokenId | Header | String | O | トークンID |
| id | Query | UUID | - | 照会するFloating IP ID |
| status | Query | Enum | - | 照会するFloating IPの状態 ACTIVE：インスタンスに接続 DOWN：インスタンスに未接続 ERROR：インスタンスに接続または割り当て失敗 |
| tenant_id | Query | String | - | 照会するFloating IPのテナントID |
| floating_network_id | Query | UUID | - | 照会するFloating IPが属す外部ネットワークID |
| fixed_ip_address | Query | String | - | 照会するFloating IPが接続された固定IPアドレス |
| floating_ip_address | Query | String | - | 照会するFloating IPアドレス |
| port_id | Query | UUID | - | 照会するFloating IPが接続されたポートID |
| sort_dir | Query | Enum | - | 照会するFloating IPのソート方向sort_keyで指定したフィールドを基準にソートasc、descのいずれか |
| sort_key | Query | String | - | 照会するFloating IPのソートキーsort_dirで指定した方向で ソート |
| fields | Query | String | - | 照会するFloating IPのフィールド名 例) fields=id&fields=name |
| 名前 | 種類 | 形式 | 説明 |
|---|---|---|---|
| floatingips | Body | Array | Floating IP情報オブジェクトリスト |
| floatingips.floating_network_id | Body | UUID | Floating IPが属す外部ネットワークID |
| floatingips.router_id | Body | UUID | Floating IPが接続されたルーターID |
| floatingips.fixed_ip_address | Body | String | Floating IPが接続された固定IPアドレス |
| floatingips.floating_ip_address | Body | String | Floating IPアドレス |
| floatingips.tenant_id | Body | String | テナントID |
| floatingips.status | Body | Enum | Floating IPの状態 ACTIVE：インスタンスに接続 DOWN：インスタンスに未接続 ERROR：インスタンスに接続または割り当て失敗 |
| floatingips.port_id | Body | UUID | Floating IPが接続されたポートID |
| floatingips.id | Body | UUID | Floating IP ID |
{
"floatingips": [
{
"floating_network_id": "4b61db01-8183-4540-b2a3-47254a58298d",
"router_id": null,
"fixed_ip_address": null,
"floating_ip_address": "133.186.242.214",
"tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
"status": "DOWN",
"port_id": null,
"id": "fed3fcf6-59b1-4f43-93e5-23a47cb5452e"
}
]
}
指定したFloating IPの情報を返します。
GET /v2.0/floatingips/{floatingIpId}
X-Auth-Token: {tokenId}
このAPIはリクエスト本文を要求しません。
| 名前 | 種類 | 形式 | 必須 | 説明 |
|---|---|---|---|---|
| floatingIpId | URL | UUID | O | Floating IP ID |
| tokenId | Header | String | O | トークンID |
| 名前 | 種類 | 形式 | 説明 |
|---|---|---|---|
| floatingip | Body | Object | Floating IP情報オブジェクト |
| floatingip.floating_network_id | Body | UUID | Floating IPが属す外部ネットワークID |
| floatingip.router_id | Body | UUID | Floating IPが接続されたルーターID |
| floatingip.fixed_ip_address | Body | String | Floating IPが接続された固定IPアドレス |
| floatingip.floating_ip_address | Body | String | Floating IPアドレス |
| floatingip.tenant_id | Body | String | テナントID |
| floatingip.status | Body | Enum | Floating IPの状態 ACTIVE：インスタンスに接続 DOWN：インスタンスに未接続 ERROR：インスタンスに接続または割り当て失敗 |
| floatingip.port_id | Body | UUID | Floating IPが接続されたポートID |
| floatingip.id | Body | UUID | Floating IP ID |
{
"floatingip": {
"floating_network_id": "4b61db01-8183-4540-b2a3-47254a58298d",
"router_id": null,
"fixed_ip_address": null,
"floating_ip_address": "133.186.242.214",
"tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
"status": "DOWN",
"port_id": null,
"id": "fed3fcf6-59b1-4f43-93e5-23a47cb5452e"
}
}
Floating IPを作成します。
POST /v2.0/floatingips
X-Auth-Token: {tokenId}
| 名前 | 種類 | 形式 | 必須 | 説明 |
|---|---|---|---|---|
| tokenId | Header | String | O | トークンID |
| floatingip | Body | Object | O | Floating IP作成リクエストオブジェクト |
| floatingip.floating_network_id | Body | UUID | O | Floating IPが属す外部ネットワークID |
| floatingip.port_id | Body | UUID | - | Floating IPが接続されるポートID |
{
"floatingip": {
"floating_network_id": "4b61db01-8183-4540-b2a3-47254a58298d",
"port_id": null
}
}
| 名前 | 種類 | 形式 | 説明 |
|---|---|---|---|
| floatingip | Body | Object | Floating IP情報オブジェクト |
| floatingip.floating_network_id | Body | UUID | Floating IPが属す外部ネットワークID |
| floatingip.router_id | Body | UUID | Floating IPが接続されたルーターID |
| floatingip.fixed_ip_address | Body | String | Floating IPが接続された固定IPアドレス |
| floatingip.floating_ip_address | Body | String | Floating IPアドレス |
| floatingip.tenant_id | Body | String | テナントID |
| floatingip.status | Body | Enum | Floating IPの状態 ACTIVE：インスタンスに接続 DOWN：インスタンスに未接続 ERROR：インスタンスに接続または割り当て失敗 |
| floatingip.port_id | Body | UUID | Floating IPが接続されたポートID |
| floatingip.id | Body | UUID | Floating IP ID |
{
"floatingip": {
"floating_network_id": "4b61db01-8183-4540-b2a3-47254a58298d",
"router_id": null,
"fixed_ip_address": null,
"floating_ip_address": "133.186.242.214",
"tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
"status": "DOWN",
"port_id": null,
"id": "fed3fcf6-59b1-4f43-93e5-23a47cb5452e"
}
}
PUT /v2.0/floatingips/{floatingIpId}
X-Auth-Token: {tokenId}
| 名前 | 種類 | 形式 | 必須 | 説明 |
|---|---|---|---|---|
| floatingIpId | URL | UUID | Floating IP ID | |
| tokenId | Header | String | O | トークンID |
| floatingip | Body | Object | O | Floating IP修正リクエストオブジェクト |
| floatingip.port_id | Body | UUID | O | Floating IPを接続するポートID 解除するには nullを入力 |
| floatingip.fixed_ip_address | Body | String | - | 固定IPアドレス 接続または解除するポートに複数のIPが割り当てられている場合、特定のIPを指定するために使用 |
{
"floatingip": {
"port_id": "af41e9f7-18ae-43c5-8b7e-7026f792bf3a"
}
}
| 名前 | 種類 | 形式 | 説明 |
|---|---|---|---|
| floatingip | Body | Object | Floating IP情報オブジェクト |
| floatingip.floating_network_id | Body | UUID | Floating IPが属す外部ネットワークID |
| floatingip.router_id | Body | UUID | Floating IPが接続されたルーターID |
| floatingip.fixed_ip_address | Body | String | Floating IPが接続された固定IPアドレス |
| floatingip.floating_ip_address | Body | String | Floating IPアドレス |
| floatingip.tenant_id | Body | String | テナントID |
| floatingip.status | Body | Enum | Floating IPの状態 |
| floatingip.port_id | Body | UUID | Floating IPが接続されたポートID |
| floatingip.id | Body | UUID | Floating IP ID |
{
"floatingip": {
"floating_network_id": "b04b1c31-f2e9-4ae0-a264-02b7d61ad618",
"router_id": "4337119f-8c72-40bf-818a-21258ecb86db",
"fixed_ip_address": "192.168.22.96",
"floating_ip_address": "133.186.147.40",
"tenant_id": "f5073eaa26b64cffbee89411df94ce01",
"status": "DOWN",
"port_id": "af41e9f7-18ae-43c5-8b7e-7026f792bf3a",
"id": "5338b5b2-9d80-46b5-ba13-2fd13f5c498a"
}
}
指定したFloating IPを削除します。
DELETE /v2.0/floatingips/{floatingIpId}
X-Auth-Token: {tokenId}
このAPIはリクエスト本文を要求しません。
| 名前 | 種類 | 形式 | 必須 | 説明 |
|---|---|---|---|---|
| floatingIpId | URL | UUID | O | Floating IP ID |
| tokenId | Header | String | O | トークンID |
このAPIはレスポンス本文を返しません。